// 版权所有2009 Go作者。保留所有权利。
// 此源代码的使用受BSD样式
// 许可证的约束，该许可证可以在许可证文件中找到。

// go:build aix | |达尔文| | |蜻蜓| | freebsd | | |（js&wasm）| | linux | | netbsd | openbsd | solaris 

package os

import (
	"internal/poll"
	"internal/syscall/unix"
	"runtime"
	"syscall"
)

// 。
func fixLongPath(path string) string {
	return path
}

func rename(oldname, newname string) error {
	fi, err := Lstat(newname)
	if err == nil && fi.IsDir() {
		// 此函数可以返回两个独立的错误：
		// 一个错误表示旧名不好，一个错误表示新名不好。
		// 现在我们已经确定这个新名字不好。
		// 但为了防止oldname也不好，请优先返回
		// oldname错误，因为我们在历史上就是这样做的。
		// 但是，如果旧名称和新名称不相同，但
		// 它们引用的是同一个文件，这意味着在不区分大小写的文件系统上只使用大小写的
		// 重命名，这是可以的。
		if ofi, err := Lstat(oldname); err != nil {
			if pe, ok := err.(*PathError); ok {
				err = pe.Err
			}
			return &LinkError{"rename", oldname, newname, err}
		} else if newname == oldname || !SameFile(fi, ofi) {
			return &LinkError{"rename", oldname, newname, syscall.EEXIST}
		}
	}
	err = ignoringEINTR(func() error {
		return syscall.Rename(oldname, newname)
	})
	if err != nil {
		return &LinkError{"rename", oldname, newname, err}
	}
	return nil
}

// 文件是*文件的真实表示。
// 额外的间接级别确保操作系统
// 的任何客户端都不能覆盖此数据，这可能会导致终结器
// 关闭错误的文件描述符。
type file struct {
	pfd         poll.FD
	name        string
	dirinfo     *dirInfo // nil除非正在读取的目录
	nonblock    bool     // 我们是否设置了非阻塞模式
	stdoutOrErr bool     // 这是标准输出还是标准输出
	appendMode  bool     // 是否打开文件以追加
}

// Fd返回引用打开文件的整数Unix文件描述符。
// 如果关闭f，文件描述符将无效。
// 如果f被垃圾收集，终结器可能会关闭文件描述符，
// 使其无效；请参阅运行时。SetFinalizer获取有关何时运行
// 终结器的更多信息。在Unix系统上，这将导致SetDeadline 
// 方法停止工作。
// 由于文件描述符可以重用，因此返回的文件描述符只能通过f的Close方法关闭，也可以在
// 垃圾收集期间由其终结器关闭。否则，在垃圾回收期间，终结器
// 可能会关闭具有相同（重用）编号的不相关文件描述符。
// 
// 作为替代方法，请参见f.SyscallConn方法。
func (f *File) Fd() uintptr {
	if f == nil {
		return ^(uintptr(0))
	}

	// 如果我们将文件描述符设置为非阻塞模式，
	// 然后在返回之前将其设置为阻塞模式，
	// 因为历史上我们总是返回在阻塞模式下打开的描述符
	// 。该文件将继续工作，但任何阻塞操作都会占用一个线程。
	if f.nonblock {
		f.pfd.SetBlocking()
	}

	return uintptr(f.pfd.Sysfd)
}

// NewFile返回一个具有给定文件描述符和
// 名称的新文件。如果fd不是有效的文件
// 描述符，则返回值为零。在Unix系统上，如果文件描述符处于
// 非阻塞模式，则NewFile将尝试返回一个可轮询文件
// （SetDeadline方法适用的文件）。
// 
// 在将其传递到新文件后，fd可能在fd方法注释中描述的相同
// 条件下无效，并且相同的
// 约束适用。
func NewFile(fd uintptr, name string) *File {
	kind := kindNewFile
	if nb, err := unix.IsNonblock(int(fd)); err == nil && nb {
		kind = kindNonBlock
	}
	return newFile(fd, name, kind)
}

// newFileKind描述了新文件的文件类型。
type newFileKind int

const (
	kindNewFile newFileKind = iota
	kindOpenFile
	kindPipe
	kindNonBlock
)

// newFile类似于newFile，但如果从OpenFile或管道调用
// （在kind参数中传递），它会尝试将文件添加到运行时轮询器
// 。
func newFile(fd uintptr, name string, kind newFileKind) *File {
	fdi := int(fd)
	if fdi < 0 {
		return nil
	}
	f := &File{&file{
		pfd: poll.FD{
			Sysfd:         fdi,
			IsStream:      true,
			ZeroReadIsEOF: true,
		},
		name:        name,
		stdoutOrErr: fdi == 1 || fdi == 2,
	}}

	pollable := kind == kindOpenFile || kind == kindPipe || kind == kindNonBlock

	// 如果调用方传递了一个非阻塞文件des（kindNonBlock），
	// 我们假设他们知道自己在做什么，所以我们允许它与kqueue一起使用。
	if kind == kindOpenFile {
		switch runtime.GOOS {
		case "darwin", "ios", "dragonfly", "freebsd", "netbsd", "openbsd":
			var st syscall.Stat_t
			err := ignoringEINTR(func() error {
				return syscall.Fstat(fdi, &st)
			})
			typ := st.Mode & syscall.S_IFMT
			// 不要尝试在*BSD上对常规文件使用kqueue。
			// 在FreeBSD上，常规文件总是
			// 报告为准备写入。
			// 在Dragonfly、NetBSD和OpenBSD上，fd只在准备就绪时发出一次信号
			// 读取和写入。
			// 第19093期。
			// 也不要向netpoller添加目录。
			if err == nil && (typ == syscall.S_IFREG || typ == syscall.S_IFDIR) {
				pollable = false
			}

			// 除了上述常规文件的行为外，在达尔文，kqueue不能与FIFO正常工作：
			// 关闭最后一个写入程序不会导致任何读卡器发生kqueue事件
			// 。见第24164期。
			if (runtime.GOOS == "darwin" || runtime.GOOS == "ios") && typ == syscall.S_IFIFO {
				pollable = false
			}
		}
	}

	if err := f.pfd.Init("file", pollable); err != nil {
		// 此处的错误表示未能向netpoll系统注册
		// 。这可能发生在
		// 一个不受
		// epoll/kqueue支持的文件描述符上；例如，
		// Linux系统上的磁盘文件。我们假设任何真正的错误
		// 都将出现在以后的I/O中。
	} else if pollable {
		// 我们已成功地在netpoll注册，因此请将
		// 将文件转换为非阻塞模式。
		if err := syscall.SetNonblock(fdi, true); err == nil {
			f.nonblock = true
		}
	}

	runtime.SetFinalizer(f.file, (*file).close)
	return f
}

// 如果我们在标准
// 输出或标准错误上得到EPIPE错误，epipecheck将引发SIGPIPE。请参阅os/signal中的SIGPIPE文档，以及
// 11845期。
func epipecheck(file *File, e error) {
	if e == syscall.EPIPE && file.stdoutOrErr {
		sigpipe()
	}
}

// DevNull是操作系统的“空设备”的名称
// 在类Unix系统上，它是“/dev/null”；在Windows上，“NUL”。
const DevNull = "/dev/null"

// openFileNolog是OpenFile的Unix实现。
// 如果相关，此处的更改应反映在openFdAt中。
func openFileNolog(name string, flag int, perm FileMode) (*File, error) {
	setSticky := false
	if !supportsCreateWithStickyBit && flag&O_CREATE != 0 && perm&ModeSticky != 0 {
		if _, err := Stat(name); IsNotExist(err) {
			setSticky = true
		}
	}

	var r int
	for {
		var e error
		r, e = syscall.Open(name, flag|syscall.O_CLOEXEC, syscallMode(perm))
		if e == nil {
			break
		}

		// 我们必须根据第11180期和第39237期检查此处的电子信息。
		if e == syscall.EINTR {
			continue
		}

		return nil, &PathError{Op: "open", Path: name, Err: e}
	}

	// open（2）本身无法处理*BSD和Solaris上的粘性部分
	if setSticky {
		setStickyBit(name)
	}

	// 这里有一场与fork/exec的竞赛，我们满足于与之共存。看/syscall/exec_unix。去
	if !supportsCloseOnExec {
		syscall.CloseOnExec(r)
	}

	return newFile(uintptr(r), name, kindOpenFile), nil
}

func (file *file) close() error {
	if file == nil {
		return syscall.EINVAL
	}
	if file.dirinfo != nil {
		file.dirinfo.close()
		file.dirinfo = nil
	}
	var err error
	if e := file.pfd.Close(); e != nil {
		if e == poll.ErrFileClosing {
			e = ErrClosed
		}
		err = &PathError{Op: "close", Path: file.name, Err: e}
	}

	// 不再需要终结器
	runtime.SetFinalizer(file, nil)
	return err
}

// seek将下一次读取或写入文件的偏移量设置为偏移量，解释
// 根据何处：0表示相对于文件原点，1表示相对于当前偏移量，2表示相对于结束。
// 返回新的偏移量和错误（如果有）。
func (f *File) seek(offset int64, whence int) (ret int64, err error) {
	if f.dirinfo != nil {
		// 释放缓存的dirinfo，因此如果我们再次将此文件作为目录访问，我们将分配一个新的dirinfo。参见35767和35161。
		f.dirinfo.close()
		f.dirinfo = nil
	}
	ret, err = f.pfd.Seek(offset, whence)
	runtime.KeepAlive(f)
	return ret, err
}

// Truncate更改命名文件的大小。
// 如果文件是符号链接，它会更改链接目标的大小。
// 如果有错误，则类型为*PathError。
func Truncate(name string, size int64) error {
	e := ignoringEINTR(func() error {
		return syscall.Truncate(name, size)
	})
	if e != nil {
		return &PathError{Op: "truncate", Path: name, Err: e}
	}
	return nil
}

// Remove删除指定的文件或（空）目录。
// 如果有错误，则类型为*PathError。
func Remove(name string) error {
	// 系统调用接口迫使我们知道
	// 名称是文件还是目录。
	// 两个都试试：平均来说，这比
	// 做一个统计加上正确的统计要便宜。
	e := ignoringEINTR(func() error {
		return syscall.Unlink(name)
	})
	if e == nil {
		return nil
	}
	e1 := ignoringEINTR(func() error {
		return syscall.Rmdir(name)
	})
	if e1 == nil {
		return nil
	}

	// 两个都失败：找出要返回的错误。
	// OS X和Linux在是否取消链接（dir）
	// 返回EISDIR上存在差异，因此不能使用该选项。然而，
	// 双方都同意rmdir（file）返回ENOTDIR，
	// 所以我们可以用它来决定哪个错误是真实的。
	// Rmdir如果给定了一个错误的
	// 文件路径，比如/etc/passwd/foo，也可能返回ENOTDIR，但是在这种情况下，
	// 两个错误都是ENOTDIR，所以可以使用unlink的错误。
	if e1 != syscall.ENOTDIR {
		e = e1
	}
	return &PathError{Op: "remove", Path: name, Err: e}
}

func tempDir() string {
	dir := Getenv("TMPDIR")
	if dir == "" {
		if runtime.GOOS == "android" {
			dir = "/data/local/tmp"
		} else {
			dir = "/tmp"
		}
	}
	return dir
}

// Link创建newname作为指向oldname文件的硬链接。
// 如果有错误，它将是*LinkError类型。
func Link(oldname, newname string) error {
	e := ignoringEINTR(func() error {
		return syscall.Link(oldname, newname)
	})
	if e != nil {
		return &LinkError{"link", oldname, newname, e}
	}
	return nil
}

// Symlink创建newname作为指向oldname的符号链接。
// 在Windows上，指向不存在的旧名称的符号链接会创建一个文件符号链接；
// 如果以后将oldname创建为目录，则符号链接将不起作用。
// 如果有错误，它将是*LinkError类型。
func Symlink(oldname, newname string) error {
	e := ignoringEINTR(func() error {
		return syscall.Symlink(oldname, newname)
	})
	if e != nil {
		return &LinkError{"symlink", oldname, newname, e}
	}
	return nil
}

// Readlink返回指定符号链接的目标。
// 如果有错误，则类型为*PathError。
func Readlink(name string) (string, error) {
	for len := 128; ; len *= 2 {
		b := make([]byte, len)
		var (
			n int
			e error
		)
		for {
			n, e = fixCount(syscall.Readlink(name, b))
			if e != syscall.EINTR {
				break
			}
		}
		// 缓冲区太小
		if runtime.GOOS == "aix" && e == syscall.ERANGE {
			continue
		}
		if e != nil {
			return "", &PathError{Op: "readlink", Path: name, Err: e}
		}
		if n < len {
			return string(b[0:n]), nil
		}
	}
}

type unixDirent struct {
	parent string
	name   string
	typ    FileMode
	info   FileInfo
}

func (d *unixDirent) Name() string   { return d.name }
func (d *unixDirent) IsDir() bool    { return d.typ.IsDir() }
func (d *unixDirent) Type() FileMode { return d.typ }

func (d *unixDirent) Info() (FileInfo, error) {
	if d.info != nil {
		return d.info, nil
	}
	return lstat(d.parent + "/" + d.name)
}

func newUnixDirent(parent, name string, typ FileMode) (DirEntry, error) {
	ude := &unixDirent{
		parent: parent,
		name:   name,
		typ:    typ,
	}
	if typ != ^FileMode(0) && !testingForceReadDirLstat {
		return ude, nil
	}

	info, err := lstat(parent + "/" + name)
	if err != nil {
		return nil, err
	}

	ude.typ = info.Mode().Type()
	ude.info = info
	return ude, nil
}
